Interface MgntAccessSettingManager

All Superinterfaces:
IPCObject
All Known Implementing Classes:
MgntAccessSettingManagerImpl

public interface MgntAccessSettingManager extends IPCObject
Information provided by the PKI file:

    \class CMgntAccessSettingManager
    
    \brief CMgntAccessSettingManager is the asa object storage manager class that is used to store and retrieve asa object.
    
    \example network().getDevice("Router0").getAsaMgntAccessManager()
    
Author:
Auto-generated
  • Method Details

    • deleteIpv4MgntAccessSetting

      boolean deleteIpv4MgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, IPAddress allowedMask, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Delete the access configuration that matches protocol, allowed ip address, allowed mask and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedMask, mask
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the delete was successful, false if not.
          
              
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedMask - Takes in a parameter of allowedMask
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • deleteIpv6MgntAccessSetting

      boolean deleteIpv6MgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, int allowedPrefix, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Delete the access configuration that matches protocol, allowed ip address, allowed prefix and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedPrefix, ipv6 prefix
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the delete was successful, false if not.
          
              
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedPrefix - Takes in a parameter of allowedPrefix
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • addMgntAccessSetting

      boolean addMgntAccessSetting(AccessProtocol protocol, IPAddress allowedIp, IPAddress allowedMask, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Add the access configuration that matches protocol, allowed ip address, allowed mask and nameIf
          
          \param protocol, ssh/telnet/http
          \param allowedIp, ip address
          \param allowedMask, mask
          \param srcNameIf, nameIf of the interface that allow remote access
          
          \return bool, value is true if the add was successful, false if not.
          
              
      Parameters:
      protocol - Takes in a parameter of protocol
      allowedIp - Takes in a parameter of allowedIp
      allowedMask - Takes in a parameter of allowedMask
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean
    • getMgntAccessSettingAt

      MgntAccessSetting getMgntAccessSettingAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the access setting a specified index
          
          \param index, index to retrive the access setting from.  Range (0, getMgntAccessSettingCount()).
          
          \return CMgntAccessSetting, value is the access setting a specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      MgntAccessSetting Returns a MgntAccessSetting
    • getMgntAccessSettingCount

      int getMgntAccessSettingCount()
      Information provided by the PKI file:
      
          \brief Return the number of access setting
          
          \return int, value is the number of access settings.
          
              
      Returns:
      int Returns a int
    • setSshTimeout

      void setSshTimeout(int timeout)
      Information provided by the PKI file:
      
          \brief Set the ssh timeout for ssh connection
          
          \param timeout, in minutes
          
              
      Parameters:
      timeout - Takes in a parameter of timeout
    • getSshTimeout

      int getSshTimeout()
      Information provided by the PKI file:
      
          \brief Return the ssh timeout
          
          \return int, value is the ssh timeout.
          
              
      Returns:
      int Returns a int
    • setTelnetTimeout

      void setTelnetTimeout(int timeout)
      Information provided by the PKI file:
      
          \brief Set the telnet timeout for telnet connection
          
          \param timeout, in minutes
          
              
      Parameters:
      timeout - Takes in a parameter of timeout
    • getTelnetTimeout

      int getTelnetTimeout()
      Information provided by the PKI file:
      
          \brief Return the Telnet timeout
          
          \return int, value is the Telnet timeout.
          
              
      Returns:
      int Returns a int
    • allow

      boolean allow(AccessProtocol protocol, IPAddress ipAddress, String srcNameIf)
      Information provided by the PKI file:
      
          \brief Check to see if the traffic that matches protocol, ipAddress into srcNameIf allowed or not
          
          \param protocol, ssh/telnet/http
          \param ipAddress, source ip address of the host
          \param srcNameIf, the nameif of the interface in which the host is trying to gain access into
          
          \return bool, value is true if the traffic that matches protocol, ipAddress into srcNameIf allowed, false if not.
          
              
      Parameters:
      protocol - Takes in a parameter of protocol
      ipAddress - Takes in a parameter of ipAddress
      srcNameIf - Takes in a parameter of srcNameIf
      Returns:
      boolean Returns a boolean